docs: fix first-package guide (includes: auto explained, correct skill paths)#1129
Merged
danielmeppiel merged 1 commit intomainfrom May 4, 2026
Merged
Conversation
Three corrections, all verified empirically against latest main: 1. The shown apm.yml is missing 'includes: auto'. apm init -y emits that field today (added in #887 so day-2 audits don't surprise the maintainer with an 'includes not declared' advisory). Without it, step 4's 'apm install with no args deploys local content' is a lie. 2. Explain WHY apm install (no args) deploys .apm/. The mechanism is includes: auto -- it's the load-bearing field the previous version left invisible. Without this paragraph, removing the field looks harmless and silently breaks local deployment. 3. Skill output path was wrong. Post-skill-routing convergence, skills land under .agents/skills/ (the cross-client universal location) for Copilot/Cursor/OpenCode/Codex/Gemini. Only Claude keeps .claude/skills/. The doc still showed .github/skills/ for both the install output snippet and the tree diagram. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the “Your First Package” guide to match current apm init / apm install behavior, specifically around the scaffolded manifest fields and where skills vs agents are deployed.
Changes:
- Adds
includes: autoto the exampleapm.ymland explains what it means. - Fixes the documented install output to show skills integrating to
.agents/skills/(while agents integrate to.github/agents/). - Updates the directory tree diagram to reflect the
.agents/(skills) +.github/(agents) split.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/getting-started/first-package.md | Aligns the first-package getting-started guide with current manifest scaffold and skill/agent install routing paths. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 2
Comment on lines
+55
to
+59
| `includes: auto` is the field that makes step 4 work: with no remote | ||
| dependencies declared, `apm install` walks your local `.apm/` tree | ||
| and deploys what it finds. Set `includes: []` (or omit the field) and | ||
| local content stops deploying. Override with an explicit list of | ||
| paths to gate exactly what ships. |
| +-- .agents/ # generated -- cross-client skills | ||
| | +-- skills/ | ||
| | | +-- pr-description/SKILL.md | ||
| | +-- pr-description/SKILL.md |
This was referenced May 4, 2026
danielmeppiel
added a commit
that referenced
this pull request
May 5, 2026
Roll forward the four PRs merged since v0.12.1: - #1137 feat(audit): default-on integration drift detection - #1135 fix(deps): subdir-agnostic bare cache (parallel sparse-checkout race) also resolves duplicate report #1140 (ADO sub-path manifestation) - #1129 docs: first-package guide accuracy (includes: auto, skill paths) - #1127 docs: APM's role for skills, plugins-as-packages, ADO sub-paths Bump pyproject.toml + uv.lock 0.12.1 -> 0.12.2 and convert the Unreleased CHANGELOG block into the 0.12.2 section, with a single 'so what' line per merged PR per the changelog contract. Co-authored-by: Daniel Meppiel <copilot-rework@github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Three empirically-verified corrections to
getting-started/first-package.md(Your First Package). All three were silently wrong:apm init -yemitsincludes: auto, that field is what makesapm install(no args) work, and skills no longer land under.github/skills/.Why
While reviewing the docs against actual behavior on
main, I ranapm init -y team-skillsfollowed byapm installagainst the exact tree the guide tells users to build. Three discrepancies surfaced:apm.ymlis shown withoutincludes: autoapm init -ywritesincludes: auto(added in #887).apm/content" with no further explanationincludes: auto. Setincludes: [](or omit the field) and local content stops deploying. The load-bearing field was invisible to the reader..github/skills/.agents/skills/(cross-client universal) per the routing convergence. Agents stay under.github/agents/.The first two compound: if a user copy-pastes the doc's
apm.ymlover the generated one, they loseincludes: autoand step 4 silently does nothing.What
includes: autoto match whatapm init -yactually writes. Add a paragraph explaining the field is load-bearing for step 4 and what[]/ explicit list overrides mean.1 skill(s) integrated -> .agents/skills/(was.github/skills/). Plural agents string aligns with currentCommandLoggeroutput. Added a paragraph explaining the agent/skill split (runtime-specific vs cross-client) and the Claude exception..agents/skills/for the skill,.github/agents/for the agent.Validation
Both differences confirmed against
mainHEAD.How to test
Trade-offs
apm compilevsapm install-- that distinction is still correct.Follow-up (not in this PR)
While here I noticed
getting-started/migration.md(sidebar title "Existing Projects") muddles two audiences:CHANGELOG.mdor a dedicated "Upgrading" page)Worth a separate PR to relocate. Not bundling here to keep this one focused.
Related
includes: autoinapm init)